Tableau Serverのコマンドユーティリティ「tabcmd」入門 #tableau
はじめに
こんにちは。大阪オフィス唯一のDI部メンバー、tamaです。
本エントリは、Tableau Server Qualified Associateの試験ガイド「評価するスキル」に関連する内容となります。
- ※2018年4月にバージョン2018.1がリリースされましたが、2018年5月現在のTableau Server Qualified Associateはバージョン10.5が対象のため、バージョンで異なる仕様や挙動については、バージョン10.5を対象にしています。
本エントリの概要
今回は試験ガイドの「tabcmd」を見ていきたいと思います。
tabcmdとは
Tableau Serverには、サーバーが処理するタスクを自動化（スクリプト化）するためのツールとして、2種類のWindowsベースコマンドラインユーティリティが組み込まれています。 そのうちの1つがtabcmdです。
tabcmdは、Tableau ServerのWebUI上で出来る操作（ユーザーの登録や抽出の更新など）をコマンドで代替できるものです。
tabadminと混同しがちですが、とりあえず最初のとっかかりとしては、tabadminはTableau Serverの重要な設定を行うものに対して、tabcmdは、手動でもできる作業をコマンドで実行して楽をするもの…くらいの感じで捉えておくと良いと思います。
tabcmdのインストール方法
Tabadminとは異なり、tabcmdは別途インストールする必要があります。ちなみに、Tableau Serverが複数台構成（分散環境）の場合、プライマリノードではないマシンでもインストールすることができます。
上記はTableau Serverのインストーラーをダウンロードできるページですが、実はここにtabcmdのインストーラーもあります。
バージョン毎のページに移動し、インストーラーのダウンロード部分を見てみると、tabcmdのインストーラーもあるので、ダウンロードします。
基本的にはインストーラーを実行し、ウィザードを進めていけば、インストールは完了します。
tabcmdを使用してできることの一例
- ユーザーの作成と同期
- ブックとデータソースを公開する
- 画像とPDFを作成する
- 抽出をリフレッシュする
- スケジュールを実行する
- ブック、データソース、およびユーザーを削除する
- グループとプロジェクトの追加と削除
- グループにユーザーを追加する
- 管理タスクの自動化
tabcmdコマンドの基本構成
以下がtabcmdの基本的なコマンドの形式です。
tabcmd <command> [options]
ちなみに、tamcmdのログ（デバッグやエラーメッセージ等含む）は、以下の場所に書き込まれます。
C:\Users\<ユーザー>\AppData\Local\Tableau\Tabcmd
使用例
ログインする
tabcmd login -s http://localhost -u administrator -p training
tabcmdで何らかの処理を行いたい場合、必ず最初がこのログインコマンドから始めます。（ログインしないと、他の処理ができないため）
ログアウト
tabcmd logout
ヘルプの表示
tabcmd help
利用可能なすべてのヘルプコマンドを一覧表示する
tabcmd help commands
特定のコマンドのヘルプを表示する
tabcmd help <a command>
サイト「Default」にプロジェクトを作成する
tabcmd createproject -n "営業部" -d "営業部用のプロジェクト"
「営業部」という名称のプロジェクトをDefaultサイトに作成します。
指定したデータソース（抽出）を更新する
tabcmd refreshextracts -—datasource "売上データ"
「売上データ」という抽出ファイルを更新します。
CSVからユーザーをインポートする
tabcmd createusers "Users.csv" -license “Interactor"
「Users.csv」というファイルを用いて、ユーザーを登録します。
画像のエクスポートまたはPDF
tabcmd export "売上ダッシュボード" --pdf -f “C:\Users\Administrator\Downloads\filename”
「売上ダッシュボード」というワークブックを、PDFの形式でダウンロードフォルダにエクスポートします。
ワークブック全体を取得する
tabcmd get "売上ダッシュボード.twb" -f "C:\Users\Administrator\Downloads\売上ダッシュボード.twb"
「売上ダッシュボード」というワークブックを、ダウンロードフォルダにダウンロードします。
実践
tabcmdをインストールした環境で、実際にtabcmdを使用してみたいと思います。（プライマリノードにtabcmdをインストールした場合）
準備
コマンドプロンプトを管理者権限で起動する
tabcmdが存在するディレクトリに移動する
プライマリノードにインストールした場合は、下記のコマンドで、そちらに移動できます。
cd "C:\Program Files\Tableau\Tableau Server\<バージョン>\bin"
Tableau Serverにログインする
下記のユーザーでログインします。
tabcmd login -s http://localhost -u <ユーザー名> -p <パスワード>
プロジェクトを作成する
tabcmd createproject -n アトミックドロップ -d tabcmdのテストで作成してみた
ログアウトする
tabcmd logout
確認
ちゃんと作成されていますね。
おわりに
今回はtabcmdの基本的なところを見てきました。まずは、tabadminとtabcmdで、それぞれ出来ることに違いを把握しておきたいところです。
使いこなせば、Tableau Serverの作業がとても楽になると思います。実際にどんなことができるかは、下記の公式リファレンスを参照すれば問題ないでしょう。
